/*
 * Copyright (c) United Binary LLC.  All rights reserved.
 * 
 * This code is licensed under the MIT License
 * 
 * SEE: http://harnessit.codeplex.com/license
 * 
 */
using System;
using System.ComponentModel;

namespace UnitedBinary.UnitTests.Framework.TestItems
{
	/// <include file='comments.xml' path='Docs/TestComment/Class/*'/>
	[Serializable]
	[EditorBrowsable(EditorBrowsableState.Never)]
	public class TestComment : TestObject
	{
		// Stores the actual text.
		private string comment = "";

		/// <include file='comments.xml' path='Docs/TestComment/ctor_string/*'/>
		[EditorBrowsable(EditorBrowsableState.Never)]
		public TestComment(string comment)
		{
			if (comment == null)
			{
				comment = "";
			}

			this.comment = comment;
		}

		/// <include file='comments.xml' path='Docs/TestComment/TestObjectType/*'/>
		[EditorBrowsable(EditorBrowsableState.Never)]
		public override TestObjectTypes TestObjectType
		{
			get
			{
				return TestObjectTypes.TestComment;
			}
		}

		/// <include file='comments.xml' path='Docs/TestComment/Comment/*'/>
		[EditorBrowsable(EditorBrowsableState.Never)]
		public string Comment
		{
			get
			{
				return comment;
			}
		}
	}
}
